<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class ValidationException</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class ValidationException
</h2> (line <span class="linenumber">27</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
Exception
   |
   --<a href="../ESAPI/EnterpriseSecurityException.html">EnterpriseSecurityException</a>
      |
      --ValidationException</pre>
<p>
	<b><i>Located in File: <a href="_errors---ValidationException.php.html">/errors/ValidationException.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>A ValidationException should be thrown to indicate that the data provided by  the user or from some other external source does not match the validation  rules that have been specified for that data.</h5>
<ul>
	</ul>
<br /><hr />
<span class="type">Classes extended from ValidationException:</span>
 		<dl>
	<dt><a href="../ESAPI/ValidationAvailabilityException.html">ValidationAvailabilityException</a></dt>
		<dd>TODO: Document this class</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI/ValidationUploadException.html">ValidationUploadException</a></dt>
		<dd>TODO: Document this class</dd>
	</dl>
	</p>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">ValidationException</span>
        <a href="#method__construct" title="details" class="method-name">__construct</a>
        ([<span class="var-type">userMessage</span>&nbsp;<span class="var-name">$userMessage</span> = <span class="var-default">''</span>], [<span class="var-type">logMessage</span>&nbsp;<span class="var-name">$logMessage</span> = <span class="var-default">''</span>], [<span class="var-type">cause</span>&nbsp;<span class="var-name">$context</span> = <span class="var-default">''</span>], <span class="var-type">context</span>&nbsp;<span class="var-name">3</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">context,</span>
        <a href="#methodgetContext" title="details" class="method-name">getContext</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetContext" title="details" class="method-name">setContext</a>
        (<span class="var-type">context</span>&nbsp;<span class="var-name">$context</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="method__construct" id="method__construct"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor __construct</strong> (line <span class="linenumber">45</span>)
 </h4> 
<h4><i>ValidationException</i> <strong>__construct(
[userMessage
$userMessage = ''], [logMessage
$logMessage = ''], [cause
$context = ''], context
3)</strong></h4>
	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../ESAPI/ValidationAvailabilityException.html#method__construct">ValidationAvailabilityException::__construct()</a></dt>
		<dd>Create a new ValidationAvailabilityException</dd>
	</dl>
		<dl>
	<dt><a href="../ESAPI/ValidationUploadException.html#method__construct">ValidationUploadException::__construct()</a></dt>
		<dd>Create a new ValidationException</dd>
	</dl>
	</p>

<p><strong>Overrides :</strong> <a href="../ESAPI/EnterpriseSecurityException.html#method__construct">EnterpriseSecurityException::__construct()</a> Creates a new instance of EnterpriseSecurityException that includes a root cause</p>
	<!-- ========== Info from phpDoc block ========= -->
<h5>Instantiates a new ValidationException.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>context 3</strong>: the source that caused this exception</li>
			<li><strong>userMessage $userMessage</strong>: the message to display to users</li>
			<li><strong>logMessage $logMessage</strong>: the message logged</li>
			<li><strong>cause $context</strong>: the cause</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetContext" id="methodgetContext"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getContext</strong> (line <span class="linenumber">56</span>)
 </h4> 
<h4><i>context,</i> <strong>getContext(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the UI reference that caused this ValidationException</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the source that caused the exception, stored as a string</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodsetContext" id="methodsetContext"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setContext</strong> (line <span class="linenumber">67</span>)
 </h4> 
<h4><i>void</i> <strong>setContext(
context
$context)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Set's the UI reference that caused this ValidationException</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>context $context</strong>: the context to set, passed as a String</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

		<!-- =========== Summary =========== -->
	<h4>Inherited From Class <a href="../ESAPI/EnterpriseSecurityException.html">EnterpriseSecurityException</a></h4>
		<h4>
<img src="../media/images/PublicProperty.gif" border="0" /><strong class="property"> <a href="../ESAPI/EnterpriseSecurityException.html#var$logger">EnterpriseSecurityException::$logger</a></strong> - The logger.
	</h4> 
		<h4>
<img src="../media/images/PublicProperty.gif" border="0" /><strong class="property"> <a href="../ESAPI/EnterpriseSecurityException.html#var$logMessage">EnterpriseSecurityException::$logMessage</a></strong> - 
	</h4> 
		</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

		<!-- =========== Summary =========== -->
	<h4>Inherited From Class <a href="../ESAPI/EnterpriseSecurityException.html">EnterpriseSecurityException</a></h4>
				<h4>
<img src="../media/images/Constructor.gif" border="0" /><strong class="method"> <a href="../ESAPI/EnterpriseSecurityException.html#method__construct">EnterpriseSecurityException::__construct()</a></strong> - Creates a new instance of EnterpriseSecurityException that includes a root cause
		</h4> 

				<h4>
<img src="../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../ESAPI/EnterpriseSecurityException.html#methodgetLogMessage">EnterpriseSecurityException::getLogMessage()</a></strong> - Returns a message that is safe to display in logs, but probably not to users
		</h4> 

				<h4>
<img src="../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../ESAPI/EnterpriseSecurityException.html#methodgetUserMessage">EnterpriseSecurityException::getUserMessage()</a></strong> - Returns message that is safe to display to users
		</h4> 

				<br />
	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 16 Apr 2010 14:30:35 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>